Update microgrid client #1230
Merged
Update microgrid client #1230
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Marenz
requested review from
ela-kotulska-frequenz
and removed request for
a team
github-actions
bot
added
part:docs
There was a problem hiding this comment.
Pull Request Overview
This PR updates the microgrid client integration to the latest version by changing import paths and filtering out StreamEvents where necessary. It also updates dependency references and release notes accordingly.
- Updated import locations for ComponentId across multiple modules.
- Introduced filtering of stream events in various data stream receivers.
- Adjusted dependency declaration in pyproject.toml and updated release notes.
Reviewed Changes
Copilot reviewed 69 out of 69 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/frequenz/sdk/microgrid/_power_distributing/request.py | Updated import for ComponentId from the new location. |
| src/frequenz/sdk/microgrid/_power_distributing/power_distributing.py | Adjusted ComponentId import and removed unused import items. |
| src/frequenz/sdk/microgrid/_power_distributing/_distribution_algorithm/_battery_distribution_algorithm.py | Updated ComponentId import with consistent module path. |
| src/frequenz/sdk/microgrid/_power_distributing/_component_status/_pv_inverter_status_tracker.py | Revised ComponentId import and added stream filtering for InverterData. |
| src/frequenz/sdk/microgrid/_power_distributing/_component_status/_ev_charger_status_tracker.py | Updated imports and wrapped EVCharger receiver with filter_stream_events. |
| src/frequenz/sdk/microgrid/_power_distributing/_component_status/_component_status.py | Updated ComponentId import. |
| src/frequenz/sdk/microgrid/_power_distributing/_component_status/_battery_status_tracker.py | Applied filtering for battery and inverter receivers. |
| src/frequenz/sdk/microgrid/_power_distributing/_component_pool_status_tracker.py | Updated ComponentId import. |
| src/frequenz/sdk/microgrid/_power_distributing/_component_managers/_pv_inverter_manager/_pv_inverter_manager.py | Added filtering to inverter_data stream and updated ComponentId import. |
| src/frequenz/sdk/microgrid/_power_distributing/_component_managers/_ev_charger_manager/_states.py | Updated import order for EVChargerData and ComponentId. |
| src/frequenz/sdk/microgrid/_power_distributing/_component_managers/_ev_charger_manager/_ev_charger_manager.py | Updated import order, wrapped merged EVCharger stream with filter_stream_events. |
| src/frequenz/sdk/microgrid/_power_distributing/_component_managers/_ev_charger_manager/_config.py | Updated ComponentId import. |
| src/frequenz/sdk/microgrid/_power_distributing/_component_managers/_component_manager.py | Updated ComponentId import. |
| src/frequenz/sdk/microgrid/_power_distributing/_component_managers/_battery_manager.py | Updated ComponentId import and applied filter_stream_events to data receivers. |
| src/frequenz/sdk/microgrid/_data_sourcing/microgrid_api_source.py | Updated ComponentId import. |
| src/frequenz/sdk/microgrid/_data_sourcing/_component_metric_request.py | Updated imports for ComponentId and ComponentMetricId. |
| src/frequenz/sdk/microgrid/_data_pipeline.py | Updated ComponentId import and removed unneeded imports. |
| pyproject.toml | Updated microgrid client dependency and frequencies channels version. |
| benchmarks/power_distribution/power_distributor.py | Updated ComponentId import to reflect new module path. |
| RELEASE_NOTES.md | Updated release notes to mention microgrid client dependency changes. |
Marenz
added
the
status:blocked
llucax
reviewed
Jun 10, 2025
src/frequenz/sdk/microgrid/_power_distributing/_component_managers/_battery_manager.py
Outdated
Show resolved
Hide resolved
Marenz
force-pushed
the
microgrid_client_update
branch
from
b9cc2ff to
30b6d21
Compare
llucax
reviewed
Jun 11, 2025
Comment on lines
182
to
190
| filterwarnings = [ | ||
| "error", | ||
| "once::DeprecationWarning", | ||
| "once::PendingDeprecationWarning", | ||
| # We use a raw string (single quote) to avoid the need to escape special | ||
| # chars as this is a regex | ||
| 'ignore:Protobuf gencode version .*exactly one major version older.*:UserWarning', | ||
| ] |
There was a problem hiding this comment.
I wonder if you added this just for consistency or if you are also getting protobuf warnings at this level 😱
There was a problem hiding this comment.
I am getting warnings indeed.
There was a problem hiding this comment.
Damn, I didn't know they were so intrusive...
Marenz
force-pushed
the
microgrid_client_update
branch
from
30b6d21 to
faf2087
Compare
llucax
reviewed
Jun 11, 2025
Signed-off-by: Mathias L. Baumann <[email protected]>
Marenz
force-pushed
the
microgrid_client_update
branch
from
faf2087 to
a3de905
Compare
llucax
previously approved these changes
Jun 11, 2025
github-project-automation
bot
moved this from To do
to Review approved
in Python SDK Roadmap
github-merge-queue
bot
removed this pull request from the merge queue due to no response for status checks
ela-kotulska-frequenz
previously approved these changes
Jun 11, 2025
github-merge-queue
bot
removed this pull request from the merge queue due to no response for status checks
|
Test with nox (amd64, ubuntu-24.04, 3.13, pytest_min) is consistently timing out due to some infinite loop while cleaning up for tests (tests finish, but the reporting of warnings, etc. is never ending) 😟 |
|
Not sure if it might be related or a similar issue to the These are the logs after the tests finish(keeps looping on the last runtime error in " File "/home/runner/work/frequenz-sdk-python/frequenz-sdk-python/src/frequenz/sdk/microgrid/_power_distributing/_component_status/_battery_status_tracker.py", line 267"). |
We have no guarantee that the event loop is still running at the time the __del__ method is called. In fact we do see errors in the in the test cleanup phase exactly because of this. Signed-off-by: Mathias L. Baumann <[email protected]>
Marenz
dismissed stale reviews from ela-kotulska-frequenz and llucax
via
45c4ad7
github-actions
bot
added
the
part:actor
shsms
reviewed
Jun 16, 2025
Comment on lines
-271
to
-277
| def __del__(self) -> None: | ||
| """Destroy this instance. | ||
| Cancel all running tasks spawned by this background service. | ||
| """ | ||
| self.cancel("{self!r} was deleted") | ||
|
|
There was a problem hiding this comment.
I think the fix is to check if the event loop is running before calling cancel, because when the loop is there, we still want to cancel and cleanup.
There was a problem hiding this comment.
I thought about that, but I don't think we gain much from that tbh. Cleanup should not rely on del
shsms
approved these changes
Jun 16, 2025
github-project-automation
bot
moved this from Review approved
to Done
in Python SDK Roadmap
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Blocked by:
The release of base-client v0.11The release of microgrid client